Deprecation notices #1769

fabpot · 2015-08-16T14:18:06Z

Added a way to warn our users of deprecation features. This framework can be used for core features, but also for functions/tests/filters created by third-party. I haven't added something for tags as it can be done easily in the token parser class.

Fixes #1756 and #1767

fabpot · 2015-08-16T14:18:49Z

Forgot to mention that this is WIP, docs are not finished yet, just placeholders :)

stof · 2015-08-17T09:10:44Z

I haven't added something for tags as it can be done easily in the token parser class.

this would trigger it only during the template compilation, not at render time, so it may be hard.

stof · 2015-08-17T09:15:39Z

lib/Twig/Environment.php

@@ -448,6 +450,8 @@ public function resolveTemplate($names)
     */
    public function clearTemplateCache()
    {
+        @trigger_error(sprintf('%s is deprecated and will be removed in Twig 2.0.', __METHOD__), E_USER_DEPRECATED);


The Symfony convention for deprecation messages is to say The method __METHOD__ is deprecated since X.Y and will be removed in Z.0. Use ... instead. (the second sentence being removed if there is no alternative). What do you think about being consistent in Twig ?

I don't think we need to much details in Twig as all 1.x versions are basically interchangeable. Saying something was deprecated in 1.16 does not add anything useful.

I've tweaked some messages to make them look more Symfony-like.

Well, the documentation also says as of 1.x, which does not make sense as we always introduced the replacement in a particular version

stof · 2015-08-17T09:27:18Z

You should also trigger deprecation notices at the beginning of files for deprecated classes, as done in Symfony

stof · 2015-08-17T09:38:32Z

TokenParserBroker related methods should also be marked as deprecated as the feature is deprecated.

sstok · 2015-08-17T11:26:50Z

lib/Twig/Extension/Core.php

            new Twig_SimpleTest('same as', null, array('node_class' => 'Twig_Node_Expression_Test_Sameas')),
            new Twig_SimpleTest('none', null, array('node_class' => 'Twig_Node_Expression_Test_Null')),
            new Twig_SimpleTest('null', null, array('node_class' => 'Twig_Node_Expression_Test_Null')),
-            new Twig_SimpleTest('divisibleby', null, array('node_class' => 'Twig_Node_Expression_Test_Divisibleby')),
+            new Twig_SimpleTest('divisibleby', null, array('node_class' => 'Twig_Node_Expression_Test_Divisibleby', 'deprecated' => true, 'alternative' => 'divisibleby')),


Alternative is wrong, this should be: divisible by

fabpot · 2015-08-18T09:24:33Z

New version of the Twig_Deprecations class should be better now.

sstok · 2015-08-18T09:59:11Z

lib/Twig/Deprecations.php

+     */
+    public function collect(Traversable $iterator)
+    {
+        set_error_handler(function ($type, $msg) use (&$deprecations) {


$deprecations is not defined yet (it is defined below).
Also closures don't work in PHP 5.2 (but is that really a problem?)

Good catch, fixed.

PHP 5.2, hmmm... fixed

stof · 2015-08-18T10:18:38Z

lib/Twig/Util/DeprecationCollector.php

+{
+    private $iterator;
+
+    public function __construct(Traversable $iterator)


my comments on this class have been hidden by github because of the file renaming, but they are still valid

stof · 2015-08-18T10:34:51Z

lib/Twig/Util/DeprecationCollector.php

+
+        restore_error_handler();
+
+        return $this->deprecations;


you should reset the array of deprecation in the object property here to avoid keeping a useless reference to the array

Not sure I'm following here. You want me to add $this->deprecations = array();?

yes, so that the utility class does not keep state in memory longer than necessary. this way, the array of deprecation would not be referenced anymore by the collector once it is returned to the calling code

fabpot · 2015-08-18T11:31:09Z

Ready?

…or a set of templates

stof · 2015-08-18T12:02:59Z

👍

This PR was merged into the 1.x branch. Discussion ---------- Deprecation notices Added a way to warn our users of deprecation features. This framework can be used for core features, but also for functions/tests/filters created by third-party. I haven't added something for tags as it can be done easily in the token parser class. Fixes #1756 and #1767 Commits ------- 56c7382 added Twig_Util_DeprecationCollector to collect deprecation notices for a set of templates 2da6bae tweaked some deprecation messages cc98028 added deprecation notices for deprecated classes c6ab7de optimized legacy tests management eebfdc7 added a way to manage legacy tests in fixtures 8c4291a removed usage of deprecated features, marked some tests as being legacy b5db9dc added the Symfony PHPUnit bridge to better manage deprecation notices 23c3922 added deprecated notices for deprecated features bd87ba8 added some documentation about deprecation notices d16b7bf added a way to trigger deprecation notices for filters and functions 21f536b added deprecation for the raw tag efcfe8e added deprecation notices for deprecated tests 65e70a2 fixed CS

sstok · 2015-08-18T12:08:20Z

doc/recipes.rst

+    template names as keys and template contents as values (as done by
+    ``Twig_Util_TemplateDirIterator``).
+
+However, this code won't find all deprecations (like using deprecated some Twig


like using some deprecated Twig instead of like using deprecated some Twig

fabpot force-pushed the deprecation-notices branch 3 times, most recently from 14a089c to c011fff Compare August 16, 2015 14:28

This was referenced Aug 16, 2015

Provide a way to trigger deprecation warning in Twig #1756

Closed

Make sure deprecations are triggered in 1.x for any deprecated features #1767

Closed

fabpot force-pushed the deprecation-notices branch 13 times, most recently from 6b044ed to 582de80 Compare August 16, 2015 18:16

stof reviewed Aug 17, 2015
View reviewed changes

sstok reviewed Aug 17, 2015
View reviewed changes

fabpot force-pushed the deprecation-notices branch from 7e7dcc8 to babd35b Compare August 17, 2015 19:40

fixed CS

65e70a2

fabpot force-pushed the deprecation-notices branch from 198ad2d to a66e7df Compare August 18, 2015 09:24

sstok reviewed Aug 18, 2015
View reviewed changes

fabpot force-pushed the deprecation-notices branch 2 times, most recently from a81901f to 23a1529 Compare August 18, 2015 10:16

stof reviewed Aug 18, 2015
View reviewed changes

fabpot force-pushed the deprecation-notices branch 2 times, most recently from ed77af1 to e8b9e48 Compare August 18, 2015 10:20

stof reviewed Aug 18, 2015
View reviewed changes

fabpot force-pushed the deprecation-notices branch 2 times, most recently from 2f5723d to 481692c Compare August 18, 2015 11:30

fabpot and others added 9 commits August 18, 2015 13:34

added some documentation about deprecation notices

bd87ba8

added deprecated notices for deprecated features

23c3922

added the Symfony PHPUnit bridge to better manage deprecation notices

b5db9dc

removed usage of deprecated features, marked some tests as being legacy

8c4291a

added a way to manage legacy tests in fixtures

eebfdc7

optimized legacy tests management

c6ab7de

added deprecation notices for deprecated classes

cc98028

tweaked some deprecation messages

2da6bae

added Twig_Util_DeprecationCollector to collect deprecation notices f…

56c7382

…or a set of templates

fabpot force-pushed the deprecation-notices branch from 481692c to 56c7382 Compare August 18, 2015 11:34

fabpot merged commit 56c7382 into twigphp:1.x Aug 18, 2015

sstok reviewed Aug 18, 2015
View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecation notices #1769

Deprecation notices #1769

fabpot commented Aug 16, 2015

fabpot commented Aug 16, 2015

stof commented Aug 17, 2015

stof Aug 17, 2015

fabpot Aug 17, 2015

fabpot Aug 18, 2015

stof Aug 18, 2015

stof commented Aug 17, 2015

stof commented Aug 17, 2015

sstok Aug 17, 2015

fabpot Aug 17, 2015

fabpot commented Aug 18, 2015

sstok Aug 18, 2015

fabpot Aug 18, 2015

stof Aug 18, 2015

stof Aug 18, 2015

fabpot Aug 18, 2015

stof Aug 18, 2015

fabpot commented Aug 18, 2015

stof commented Aug 18, 2015

sstok Aug 18, 2015

Deprecation notices #1769

Deprecation notices #1769

Conversation

fabpot commented Aug 16, 2015

fabpot commented Aug 16, 2015

stof commented Aug 17, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Aug 17, 2015

stof commented Aug 17, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Aug 18, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Aug 18, 2015

stof commented Aug 18, 2015

Choose a reason for hiding this comment